Fetch Action References

Retrieves the referencing Actions and Scenarios associated with the provided Action IDs. A maximum of 25 Action IDs can be processed per request.

POST{accelqLoginUrl}/awb/api/2.0/{tenantCode}/{projectCode}/ctx/actions/references

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`projectCode`	string	Yes	Project Code found under Auth properties of ACCELQ User Profile.
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Request Body

json

Responses

200 - Successful retrieval of Action References.

json

[
  {
    "id": 463,
    "name": "Login Action",
    "referencingActions": [
      {
        "id": 465,
        "name": "Verify Fund Transfer",
        "version": "BASE"
      },
      {
        "id": 465,
        "name": "Verify Fund Transfer",
        "version": "CHECKED_OUT"
      },
      {
        "id": 475,
        "name": "Create User Role",
        "version": "BASE"
      }
    ],
    "referencingScenarios": [
      {
        "id": 27,
        "name": "QBank Sanity",
        "version": "BASE"
      },
      {
        "id": 475,
        "name": "Extract Auditing Report",
        "version": "BASE"
      }
    ]
  },
  {
    "id": 1134,
    "name": "Delete Role",
    "referencingActions": [],
    "referencingScenarios": []
  }
]

401 - Unauthorized - Invalid authentication credentials

json

{
  "error": "Invalid user credentials or API key"
}

403 - Forbidden

json

{
  "error": "User does not have authorization to access this feature"
}

500 - Internal Server Error

json

{
  "error": "Error occurred while retrieving Action References"
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

projectCode (string) *

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X POST "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/${{projectCode}}/ctx/actions/references" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '[
  463,
  1134
]'